home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xt / XtGrabKey.z / XtGrabKey
Encoding:
Text File  |  1998-10-30  |  10.3 KB  |  198 lines
  1.  
  2.  
  3.  
  4.      XXXXttttGGGGrrrraaaabbbbKKKKeeeeyyyy((((3333XXXXtttt))))     XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))      XXXXttttGGGGrrrraaaabbbbKKKKeeeeyyyy((((3333XXXXtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XtGrabKey, XtUngrabKey, XtGrabKeyboard, XtUngrabKeyboard,
  10.           XtGrabButton, XtUngrabButton, XtGrabPointer, XtUngrabPointer
  11.           - manage grabs
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           void XtGrabKey(_w_i_d_g_e_t, _k_e_y_c_o_d_e, _m_o_d_i_f_i_e_r_s, _o_w_n_e_r__e_v_e_n_t_s,
  15.           _p_o_i_n_t_e_r__m_o_d_e, _k_e_y_b_o_a_r_d__m_o_d_e)
  16.                 Widget _w_i_d_g_e_t;
  17.                 KeyCode _k_e_y_c_o_d_e;
  18.                 Modifiers _m_o_d_i_f_i_e_r_s;
  19.                 Boolean _o_w_n_e_r__e_v_e_n_t_s;
  20.                 int _p_o_i_n_t_e_r__m_o_d_e;
  21.                 int _k_e_y_b_o_a_r_d__m_o_d_e;
  22.  
  23.           void XtUngrabKey(_w_i_d_g_e_t, _k_e_y_c_o_d_e, _m_o_d_i_f_i_e_r_s)
  24.                 Widget _w_i_d_g_e_t;
  25.                 KeyCode _k_e_y_c_o_d_e;
  26.                 Modifiers _m_o_d_i_f_i_e_r_s;
  27.  
  28.           int XtGrabKeyboard(_w_i_d_g_e_t, _o_w_n_e_r__e_v_e_n_t_s, _p_o_i_n_t_e_r__m_o_d_e,
  29.           _k_e_y_b_o_a_r_d__m_o_d_e, _t_i_m_e)
  30.                 Widget _w_i_d_g_e_t;
  31.                 Boolean _o_w_n_e_r__e_v_e_n_t_s;
  32.                 int _p_o_i_n_t_e_r__m_o_d_e;
  33.                 int _k_e_y_b_o_a_r_d__m_o_d_e;
  34.                 Time _t_i_m_e;
  35.  
  36.           void XtUngrabKeyboard(_w_i_d_g_e_t, _t_i_m_e)
  37.                 Widget _w_i_d_g_e_t;
  38.                 Time _t_i_m_e;
  39.  
  40.           void XtGrabButton(_w_i_d_g_e_t, _b_u_t_t_o_n, _m_o_d_i_f_i_e_r_s, _o_w_n_e_r__e_v_e_n_t_s,
  41.           _e_v_e_n_t__m_a_s_k, _p_o_i_n_t_e_r__m_o_d_e, _k_e_y_b_o_a_r_d__m_o_d_e, _c_o_n_f_i_n_e__t_o, _c_u_r_s_o_r)
  42.                 Widget _w_i_d_g_e_t;
  43.                 int _b_u_t_t_o_n;
  44.                 Modifiers _m_o_d_i_f_i_e_r_s;
  45.                 Boolean _o_w_n_e_r__e_v_e_n_t_s;
  46.                 unsigned int _e_v_e_n_t__m_a_s_k;
  47.                 int _p_o_i_n_t_e_r__m_o_d_e;
  48.                 int _k_e_y_b_o_a_r_d__m_o_d_e;
  49.                 Window _c_o_n_f_i_n_e__t_o;
  50.                 Cursor _c_u_r_s_o_r;
  51.  
  52.           void XtUngrabButton(_w_i_d_g_e_t, _b_u_t_t_o_n, _m_o_d_i_f_i_e_r_s)
  53.                 Widget _w_i_d_g_e_t;
  54.                 KeyCode _b_u_t_t_o_n;
  55.                 Modifiers _m_o_d_i_f_i_e_r_s;
  56.  
  57.           int XtGrabPointer(_w_i_d_g_e_t, _o_w_n_e_r__e_v_e_n_t_s, _e_v_e_n_t__m_a_s_k,
  58.           _p_o_i_n_t_e_r__m_o_d_e, _k_e_y_b_o_a_r_d__m_o_d_e, _c_o_n_f_i_n_e__t_o, _c_u_r_s_o_r, _t_i_m_e)
  59.                 Widget _w_i_d_g_e_t;
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXttttGGGGrrrraaaabbbbKKKKeeeeyyyy((((3333XXXXtttt))))     XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))      XXXXttttGGGGrrrraaaabbbbKKKKeeeeyyyy((((3333XXXXtttt))))
  71.  
  72.  
  73.  
  74.                 Boolean _o_w_n_e_r__e_v_e_n_t_s;
  75.                 unsigned int _e_v_e_n_t__m_a_s_k;
  76.                 int _p_o_i_n_t_e_r__m_o_d_e;
  77.                 int _k_e_y_b_o_a_r_d__m_o_d_e;
  78.                 Window _c_o_n_f_i_n_e__t_o;
  79.                 Cursor _c_u_r_s_o_r;
  80.                 Time _t_i_m_e;
  81.  
  82.           void XtUngrabPointer(_w_i_d_g_e_t, _t_i_m_e)
  83.                 Widget _w_i_d_g_e_t;
  84.                 Time _t_i_m_e;
  85.  
  86.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  87.           _w_i_d_g_e_t    Specifies the widget in whose window the grab will
  88.                     occur. Must be of class Core or a subclass
  89.                     thereof.
  91.           _k_e_y_c_o_d_e
  92.           _m_o_d_i_f_i_e_r_s
  93.           _o_w_n_e_r__e_v_e_n_t_s
  94.           _p_o_i_n_t_e_r__m_o_d_e
  95.           _k_e_y_b_o_a_r_d__m_o_d_e
  96.           _t_i_m_e
  97.           _b_u_t_t_o_n
  98.           _c_o_n_f_i_n_e__t_o
  99.           _c_u_r_s_o_r    Specifies arguments to the associated Xlib
  100.                     function call.
  101.  
  102.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  103.           _X_t_G_r_a_b_K_e_y calls _X_G_r_a_b_K_e_y specifying the widget's window as
  104.           the grab window if the widget is realized. The remaining
  105.           arguments are exactly as for _X_G_r_a_b_K_e_y.  If the widget is not
  106.           realized, or is later unrealized, the call to _X_G_r_a_b_K_e_y will
  107.           be performed (again) when the widget is realized and its
  108.           window becomes mapped. In the future, if _X_t_D_i_s_p_a_t_c_h_E_v_e_n_t is
  109.           called with a _K_e_y_P_r_e_s_s event matching the specified keycode
  110.           and modifiers (which may be _A_n_y_K_e_y or _A_n_y_M_o_d_i_f_i_e_r,
  111.           respectively) for the widget's window, the Intrinsics will
  112.           call _X_t_U_n_g_r_a_b_K_e_y_b_o_a_r_d with the timestamp from the _K_e_y_P_r_e_s_s
  113.           event if either of the following conditions is true:
  114.  
  115.           +o  There is a modal cascade and the widget is not in the
  116.              active subset of the cascade and the keyboard was not
  117.              previously grabbed, or
  118.  
  119.           +o  _X_F_i_l_t_e_r_E_v_e_n_t returns _T_r_u_e.
  120.  
  121.           _X_t_U_n_g_r_a_b_K_e_y calls _X_U_n_g_r_a_b_K_e_y specifying the widget's window
  122.           as the ungrab window if the widget is realized. The
  123.           remaining arguments are exactly as for _X_U_n_g_r_a_b_K_e_y.  If the
  124.           widget is not realized, _X_t_U_n_g_r_a_b_K_e_y removes a deferred
  125.           _X_t_G_r_a_b_K_e_y request, if any, for the specified widget,
  126.  
  127.  
  128.      Page 2                                          (printed 4/30/98)
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.      XXXXttttGGGGrrrraaaabbbbKKKKeeeeyyyy((((3333XXXXtttt))))     XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))      XXXXttttGGGGrrrraaaabbbbKKKKeeeeyyyy((((3333XXXXtttt))))
  136.  
  137.  
  138.  
  139.           keycode, and modifiers.
  140.  
  141.           If the specified widget is realized _X_t_G_r_a_b_K_e_y_b_o_a_r_d calls
  142.           _X_G_r_a_b_K_e_y_b_o_a_r_d specifying the widget's window as the grab
  143.           window. The remaining arguments and return value are exactly
  144.           as for _X_G_r_a_b_K_e_y_b_o_a_r_d.  If the widget is not realized,
  145.           _X_t_G_r_a_b_K_e_y_b_o_a_r_d immediately returns _G_r_a_b_N_o_t_V_i_e_w_a_b_l_e.  No
  146.           future ungrab is implied by _X_t_G_r_a_b_K_e_y_b_o_a_r_d.
  147.  
  148.           _X_t_U_n_g_r_a_b_K_e_y_b_o_a_r_d calls _X_U_n_g_r_a_b_K_e_y_b_o_a_r_d with the specified
  149.           time.
  150.  
  151.           _X_t_G_r_a_b_B_u_t_t_o_n calls _X_G_r_a_b_B_u_t_t_o_n specifying the widget's
  152.           window as the grab window if the widget is realized. The
  153.           remaining arguments are exactly as for _X_G_r_a_b_B_u_t_t_o_n.  If the
  154.           widget is not realized, or is later unrealized, the call to
  155.           _X_G_r_a_b_B_u_t_t_o_n will be performed (again) when the widget is
  156.           realized and its window becomes mapped. In the future, if
  157.           _X_t_D_i_s_p_a_t_c_h_E_v_e_n_t is called with a _B_u_t_t_o_n_P_r_e_s_s event matching
  158.           the specified button and modifiers (which may be _A_n_y_B_u_t_t_o_n
  159.           or _A_n_y_M_o_d_i_f_i_e_r, respectively) for the widget's window, the
  160.           Intrinsics will call _X_t_U_n_g_r_a_b_P_o_i_n_t_e_r with the timestamp from
  161.           the _B_u_t_t_o_n_P_r_e_s_s event if either of the following conditions
  162.           is true:
  163.  
  164.           +o  There is a modal cascade and the widget is not in the
  165.              active subset of the cascade and the pointer was not
  166.              previously grabbed, or
  167.  
  168.           +o  _X_F_i_l_t_e_r_E_v_e_n_t returns _T_r_u_e.
  169.  
  170.           _X_t_U_n_g_r_a_b_B_u_t_t_o_n calls _X_U_n_g_r_a_b_B_u_t_t_o_n specifying the widget's
  171.           window as the ungrab window if the widget is realized. The
  172.           remaining arguments are exactly as for _X_U_n_g_r_a_b_B_u_t_t_o_n.  If
  173.           the widget is not realized, _X_t_U_n_g_r_a_b_B_u_t_t_o_n removes a
  174.           deferred _X_t_G_r_a_b_B_u_t_t_o_n request, if any, for the specified
  175.           widget, button, and modifiers.
  176.  
  177.           _X_t_G_r_a_b_P_o_i_n_t_e_r calls _X_G_r_a_b_P_o_i_n_t_e_r specifying the widget's
  178.           window as the grab window. The remaining arguments and
  179.           return value are exactly as for _X_G_r_a_b_P_o_i_n_t_e_r.  If the widget
  180.           is not realized, _X_t_G_r_a_b_P_o_i_n_t_e_r immediately returns
  181.           _G_r_a_b_N_o_t_V_i_e_w_a_b_l_e.  No future ungrab is implied by
  182.           _X_t_G_r_a_b_P_o_i_n_t_e_r.
  183.  
  184.           _X_t_U_n_g_r_a_b_P_o_i_n_t_e_r calls _X_U_n_g_r_a_b_P_o_i_n_t_e_r with the specified
  185.           time.
  186.  
  187.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  188.           _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s - _C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e
  189.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  190.  
  191.  
  192.  
  193.  
  194.      Page 3                                          (printed 4/30/98)
  195.  
  196.  
  197.  
  198.